Globals Guide
==============

Prior to running the code, please be sure to perform a find-and-replace in the code folder for the following expressions. These are user- and system-specific procedure parameters that will need to be filled in accordingly. Any enclosing brackets in the code files are only for highlighting these expressions and should be removed:

1. `WHOAMI`: Username of the user executing the code.
2. `CODE_PATH`: Path to the copy of this code repository on the host system.
3. `PROJECT_PATH`: Path to the root data folder for the project.
4. `PYTHON_INTERPRETER_PATH`: Path to the Python interpreter on the host system.
5. `SLURM_PARTITION`: Name of the SLURM partition to be used to execute the code.
6. `FIGI_API_KEY`: API key for Bloomberg's OpenFIGI API (https://www.openfigi.com/).

Additionally, the following corresponding globals should also be specified in the `~/shell_profile.sh` file in the user's home folder:

1. `code_path`: The same as  `CODE_PATH` above.
2. `whoami`: The same as `WHOAMI` above.
3. `project_path`: The same as `PROJECT_PATH` above.
4. `mailuser`: The email address at which to receive job notifications from the SLURM Workload Manager.
